STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

A.5.1 StructureDefinition: USLab-DO

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/uslab-do

Constraints and extensions for the US Realm laboratory ordering in ambulatory care setting

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).

A.5.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from DiagnosticOrder.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 0..*DiagnosticOrder
... identifier S1..1Identifier
.... use S1..1codeFixed Value: official
.... system S1..1uriPlacer URI
.... value S1..1stringPlacer Identifier
... status S1..1code
... priority S1..1code
... subject S1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)
... orderer S1..1Reference(US Laboratory Practitioner Profile | US Laboratory Practitioner Profile)
... reason S0..*CodeableConcept
... supportingInformation Reference(Observation | Condition | DocumentReference)Slice: Unordered, Open, by @Profile, @type
... supportingInformation S0..*Reference(US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Condition Profile | DocumentReference)
... specimen S0..*Reference(US Laboratory Specimen Profile)
... event S1..*BackboneElement
.... description S1..1CodeableConceptBinding: USLAB Diagnostic Order Event Codes (extensible)
..... coding S1..*Coding
...... system S1..1uri
...... code S1..1code
.... dateTime S I1..1dateTimeinv-2: Datetime must be at least to day.
... item S1..*BackboneElement
.... code S1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
..... coding S1..*Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string
..... text S0..1string
.... specimen S0..*Reference(US Laboratory Specimen Profile)
.... bodySite 0..0
.... status S1..1code
... uslab-cc-practitioner S0..*Reference(Practitioner)Copy to provider,organization, or patient
URL: http://hl7.org/fhir/StructureDefinition/uslab-cc-practitioner
.... valueReference S1..1Reference(US Laboratory Practitioner Profile)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 0..*DiagnosticOrderA request for a diagnostic service
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... uslab-cc-practitioner S0..*Reference(Practitioner)Copy to provider,organization, or patient
URL: http://hl7.org/fhir/StructureDefinition/uslab-cc-practitioner
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/uslab-cc-practitioner"
.... valueReference S1..1Reference(US Laboratory Practitioner Profile)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑1..1IdentifierIdentifiers assigned to this order
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringPlacer Identifier
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?! S∑1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
Binding: DiagnosticOrderStatus (required)
... priority S ∑1..1coderoutine | urgent | stat | asap
Binding: DiagnosticOrderPriority (required)
... subject S ∑1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Who and/or what test is about
... encounter ∑0..1Reference(Encounter)The encounter that this diagnostic order is associated with
... orderer S ∑1..1Reference(US Laboratory Practitioner Profile | US Laboratory Practitioner Profile)Who ordered the test
... reason S0..*CodeableConceptExplanation/Justification for test
Binding: Condition/Problem/Diagnosis Codes (example)
... supportingInformation Reference(Observation | Condition | DocumentReference)Additional clinical information
Slice: Unordered, Open, by @Profile, @type
... supportingInformation S0..*Reference(US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Condition Profile | DocumentReference)Additional clinical information
... specimen S0..*Reference(US Laboratory Specimen Profile)If the whole order relates to specific specimens
... event S1..*BackboneElementA list of events of interest in the lifecycle
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... status ∑1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
Binding: DiagnosticOrderStatus (required)
.... description S ∑1..1CodeableConceptMore information about the event and its context
Binding: USLAB Diagnostic Order Event Codes (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text ∑0..1stringPlain text representation of the concept
.... dateTime S ∑I1..1dateTimeThe date at which the event happened
inv-2: Datetime must be at least to day.
.... actor 0..1Reference(Practitioner | Device)Who recorded or did this
... item S1..*BackboneElementThe items the orderer requested
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code S ∑1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text S ∑0..1stringPlain text representation of the concept
.... specimen S0..*Reference(US Laboratory Specimen Profile)If this item relates to specific specimens
.... status S ∑1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
Binding: DiagnosticOrderStatus (required)
.... event ∑0..*Unknown reference to #event
Events specific to this item
... note 0..*AnnotationOther notes and comments

doco Documentation for this format

todo

Differential View

This structure is derived from DiagnosticOrder.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 0..*DiagnosticOrder
... identifier S1..1Identifier
.... use S1..1codeFixed Value: official
.... system S1..1uriPlacer URI
.... value S1..1stringPlacer Identifier
... status S1..1code
... priority S1..1code
... subject S1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)
... orderer S1..1Reference(US Laboratory Practitioner Profile | US Laboratory Practitioner Profile)
... reason S0..*CodeableConcept
... supportingInformation Reference(Observation | Condition | DocumentReference)Slice: Unordered, Open, by @Profile, @type
... supportingInformation S0..*Reference(US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Condition Profile | DocumentReference)
... specimen S0..*Reference(US Laboratory Specimen Profile)
... event S1..*BackboneElement
.... description S1..1CodeableConceptBinding: USLAB Diagnostic Order Event Codes (extensible)
..... coding S1..*Coding
...... system S1..1uri
...... code S1..1code
.... dateTime S I1..1dateTimeinv-2: Datetime must be at least to day.
... item S1..*BackboneElement
.... code S1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
..... coding S1..*Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string
..... text S0..1string
.... specimen S0..*Reference(US Laboratory Specimen Profile)
.... bodySite 0..0
.... status S1..1code
... uslab-cc-practitioner S0..*Reference(Practitioner)Copy to provider,organization, or patient
URL: http://hl7.org/fhir/StructureDefinition/uslab-cc-practitioner
.... valueReference S1..1Reference(US Laboratory Practitioner Profile)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 0..*DiagnosticOrderA request for a diagnostic service
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... uslab-cc-practitioner S0..*Reference(Practitioner)Copy to provider,organization, or patient
URL: http://hl7.org/fhir/StructureDefinition/uslab-cc-practitioner
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/uslab-cc-practitioner"
.... valueReference S1..1Reference(US Laboratory Practitioner Profile)Value of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑1..1IdentifierIdentifiers assigned to this order
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringPlacer Identifier
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?! S∑1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
Binding: DiagnosticOrderStatus (required)
... priority S ∑1..1coderoutine | urgent | stat | asap
Binding: DiagnosticOrderPriority (required)
... subject S ∑1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Who and/or what test is about
... encounter ∑0..1Reference(Encounter)The encounter that this diagnostic order is associated with
... orderer S ∑1..1Reference(US Laboratory Practitioner Profile | US Laboratory Practitioner Profile)Who ordered the test
... reason S0..*CodeableConceptExplanation/Justification for test
Binding: Condition/Problem/Diagnosis Codes (example)
... supportingInformation Reference(Observation | Condition | DocumentReference)Additional clinical information
Slice: Unordered, Open, by @Profile, @type
... supportingInformation S0..*Reference(US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Observation Profile | US Laboratory Condition Profile | DocumentReference)Additional clinical information
... specimen S0..*Reference(US Laboratory Specimen Profile)If the whole order relates to specific specimens
... event S1..*BackboneElementA list of events of interest in the lifecycle
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... status ∑1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
Binding: DiagnosticOrderStatus (required)
.... description S ∑1..1CodeableConceptMore information about the event and its context
Binding: USLAB Diagnostic Order Event Codes (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text ∑0..1stringPlain text representation of the concept
.... dateTime S ∑I1..1dateTimeThe date at which the event happened
inv-2: Datetime must be at least to day.
.... actor 0..1Reference(Practitioner | Device)Who recorded or did this
... item S1..*BackboneElementThe items the orderer requested
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code S ∑1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text S ∑0..1stringPlain text representation of the concept
.... specimen S0..*Reference(US Laboratory Specimen Profile)If this item relates to specific specimens
.... status S ∑1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed | entered-in-error
Binding: DiagnosticOrderStatus (required)
.... event ∑0..*Unknown reference to #event
Events specific to this item
... note 0..*AnnotationOther notes and comments

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

A.5.1.2 Terminology Bindings

PathNameConformanceValueSet
DiagnosticOrder.language?extrequiredhttp://tools.ietf.org/html/bcp47
DiagnosticOrder.identifier.useIdentifierUserequiredIdentifierUse
DiagnosticOrder.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
DiagnosticOrder.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus
DiagnosticOrder.priorityDiagnosticOrderPriorityrequiredDiagnosticOrderPriority
DiagnosticOrder.reasonCondition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes
DiagnosticOrder.event.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus
DiagnosticOrder.event.descriptionUSLAB Diagnostic Order Event CodesextensibleUSLAB Diagnostic Order Event Codes
DiagnosticOrder.item.codeUS Laboratory Observation Profile Observation Name CodesextensibleUS Laboratory Observation Profile Observation Name Codes
DiagnosticOrder.item.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus

A.5.1.3 Constraints

IdPathDetailsRequirements
inv-2DiagnosticOrder.event.dateTimeDatetime must be at least to day.
XPath: f:matches(dateTime,/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/)
.